-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
[v1][core] Support for attention free models #20811
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[v1][core] Support for attention free models #20811
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @christian-pinto, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces comprehensive support for 'attention-free models' by adapting the KV cache management system. My changes ensure that components dealing with KV cache allocation, configuration, and memory checks correctly handle models that do not require a KV cache, preventing errors and optimizing resource management for these specific model types. This is achieved by explicitly checking for and handling cases where KV cache groups are zero or empty.
Highlights
- Core KV Cache Management Adaptation: I've updated the
KVCacheCoordinator
andKVCacheManager
to gracefully handle models that do not utilize a KV cache (attention-free models). This involves adding checks to ensure that operations dependent on the existence of KV cache groups are only performed when such groups are present, preventing errors whenkv_cache_groups
is empty. - KV Cache Utility Enhancements: I've introduced new utility functions in
kv_cache_utils.py
to specifically identify and configure attention-free models. This includesis_kv_cache_type_attention_free
to detect such models and_get_kv_cache_config_attention_free
to provide a minimalKVCacheConfig
suitable for them, which is then prioritized inget_kv_cache_config
. - Memory and Spec Determination Optimization: I've optimized the
AbstractWorker
inabstract.py
to skip unnecessary memory determination and KV cache specification retrieval for attention-free models. Since these models don't use a KV cache, these operations are redundant and can be bypassed, returning default or zero values. - Memory Check Bypass: I've added a condition to
check_enough_kv_cache_memory
inkv_cache_utils.py
to bypass the memory availability check entirely if the model is identified as attention-free. This is because attention-free models do not require memory allocation for KV cache blocks.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces support for attention-free models by handling cases where the KV cache configuration is empty. I've identified a correctness issue in a new utility function and a couple of typos in comments. Once these are addressed, the PR should be in good shape.
vllm/v1/core/kv_cache_utils.py
Outdated
if not kv_cache_spec: | ||
return True |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@christian-pinto please fix it
vllm/v1/core/kv_cache_utils.py
Outdated
# This returns a kv_cahce config with 0 kv cache groups and 1 block | ||
# to allow for the KVCache manager to handle attention fre models. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vllm/v1/core/kv_cache_coordinator.py
Outdated
self.verify_and_split_kv_cache_groups() | ||
# attention free models are initialized with 0 kv_cache_groups | ||
if len(self.kv_cache_config.kv_cache_groups) > 0: | ||
self.verify_and_split_kv_cache_groups() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will revert this once #20661 is merged and the KVCacheCoordinatorNoPrefixCache
is available.
4b0a9f9
to
e06e264
Compare
👋 Hi! Thank you for contributing to the vLLM project. 💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels. Just a reminder: PRs would not trigger full CI run by default. Instead, it would only run Once the PR is approved and ready to go, your PR reviewer(s) can run CI to test the changes comprehensively before merging. To run CI, PR reviewers can either: Add 🚀 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the great work. Let's wait for #20661.
vllm/v1/core/kv_cache_utils.py
Outdated
if not kv_cache_spec: | ||
return True |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@christian-pinto please fix it
vllm/v1/core/kv_cache_manager.py
Outdated
@@ -86,7 +86,7 @@ def __init__( | |||
self.prefix_cache_stats = PrefixCacheStats() if log_stats else None | |||
|
|||
self.block_size: Optional[int] = None | |||
if self.enable_caching: | |||
if self.enable_caching and len(self.kv_cache_config.kv_cache_groups) > 0: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you fix the type error?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All looks good to me here. Am i missing something?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh I see, I have missed this one.
I'll take care of it. Thanks
vllm/v1/executor/abstract.py
Outdated
@@ -73,10 +73,16 @@ def register_failure_callback(self, callback: FailureCallback): | |||
pass | |||
|
|||
def determine_available_memory(self) -> list[int]: # in bytes | |||
if self.vllm_config.model_config.is_attention_free: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you put the change in determine_available_memory
to gpu_worker and the change inget_kv_cache_specs
to gpu_model_runner? Though these changes are platform independent, this abstract class should be as simple as possible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done
Seems that someone want prefix caching to be enabled in "last" pooling method. Is it possible to only use the zero-group code path for other pooling methods? Line 4594 in 8aeaa91
|
@christian-pinto #20661 is merged. Can you rebase? |
bb9f2db
to
177b788
Compare
To my understanding (I am not an expert on this) you should not be able to perform prefix caching if there is no KV cache, right? Therefore I would believe that if people mark a model as attention free they would also not require any prefix caching? |
Forces 0 KV Cache groups to disable KV Cache in attention free models Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
- Changes after vllm-project#20661 merge - Fixed one pre-commit error Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
177b788
to
97c11e6
Compare
Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
@DarkLight1337 @maxdebayser See the above comment. Should we enable prefix caching for "last" pooling method? I'm also not an expert on this. |
vllm/v1/core/kv_cache_coordinator.py
Outdated
@@ -388,7 +388,9 @@ def get_kv_cache_coordinator( | |||
kv_cache_config: KVCacheConfig, max_model_len: int, use_eagle: bool, | |||
enable_caching: bool, caching_hash_fn: Callable, | |||
enable_kv_cache_events: bool) -> KVCacheCoordinator: | |||
if not enable_caching: | |||
if not enable_caching or len(kv_cache_config.kv_cache_groups) == 0: | |||
# We instantiate this coordinator also for attention free models that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need this given prefix caching is disabled here for models that don’t use last pooling method?
https://github.com/maxdebayser/vllm/blob/221f013922c0c118b682d294755e69990b2c43ed/vllm/config.py#L4505
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Without this check though you would not be able to disable attention for models that are not of the pooling type as prefix caching is enabled by default for all models except pooling ones.
See below:
Lines 1620 to 1630 in 38efa28
def _set_default_args_v1(self, usage_context: UsageContext, | |
model_config: ModelConfig) -> None: | |
"""Set Default Arguments for V1 Engine.""" | |
# V1 always uses chunked prefills and prefix caching | |
# for non-pooling tasks. | |
# For pooling tasks the default is False | |
if model_config.runner_type != "pooling": | |
self.enable_chunked_prefill = True | |
if self.enable_prefix_caching is None: | |
self.enable_prefix_caching = True |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps the safest thing to do is to disable prefix-caching in VllmConfig.__post_init__
right away for any attention free models and then yes, we could just rely on enable_caching
as you suggest.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove this comment?
vllm/v1/core/kv_cache_manager.py
Outdated
@@ -89,7 +89,7 @@ def __init__( | |||
self.prefix_cache_stats = PrefixCacheStats() if log_stats else None | |||
|
|||
self.block_size: Optional[int] = None | |||
if self.enable_caching: | |||
if self.enable_caching and len(kv_cache_config.kv_cache_groups) > 0: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same as above. Don’t need if enable_caching is false for attention free models.
@heheda12345 , last pooling with prefix caching should only be enabled for decoder models with kv-cache. |
@maxdebayser I have noticed that the logic looking after enabling/disabling chunked prefill and prefix caching for pooling models is kinda duplicated? Is this intentional in case the |
Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
0923e34
to
fb3ecfb
Compare
@heheda12345 with fb3ecfb I disable chunked prefill and prefix aching for all attention free models. This Way the changes to the KVCacheCoordinator ad KVCacheManager are further reduced. |
… retention Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for your patience. Sorry for didn't noticing the bug related to mamba layers.
vllm/v1/worker/gpu_worker.py
Outdated
@@ -209,6 +209,7 @@ def determine_available_memory(self) -> int: | |||
You may limit the usage of GPU memory | |||
by adjusting the `gpu_memory_utilization` parameter. | |||
""" | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove this?
vllm/v1/core/kv_cache_coordinator.py
Outdated
@@ -388,7 +388,9 @@ def get_kv_cache_coordinator( | |||
kv_cache_config: KVCacheConfig, max_model_len: int, use_eagle: bool, | |||
enable_caching: bool, caching_hash_fn: Callable, | |||
enable_kv_cache_events: bool) -> KVCacheCoordinator: | |||
if not enable_caching: | |||
if not enable_caching or len(kv_cache_config.kv_cache_groups) == 0: | |||
# We instantiate this coordinator also for attention free models that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove this comment?
vllm/v1/core/kv_cache_manager.py
Outdated
self.enable_caching = (enable_caching | ||
if len(kv_cache_config.kv_cache_groups) > 0 | ||
else False) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
self.enable_caching = (enable_caching | |
if len(kv_cache_config.kv_cache_groups) > 0 | |
else False) | |
```suggestions | |
if len(kv_cache_config.kv_cache_groups) == 0: | |
# Attention free models don't have kv cache, thus don't need prefix caching. | |
enable_caching = False | |
self.enable_caching = enable_caching |
I think this structure is more clear for readers.
vllm/v1/engine/core.py
Outdated
check_available_memory = not(len(kv_cache_specs) == 1 and not kv_cache_specs[0]) | ||
available_gpu_memory = [0] | ||
if check_available_memory: | ||
available_gpu_memory = ( | ||
self.model_executor.determine_available_memory()) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
check_available_memory = not(len(kv_cache_specs) == 1 and not kv_cache_specs[0]) | |
available_gpu_memory = [0] | |
if check_available_memory: | |
available_gpu_memory = ( | |
self.model_executor.determine_available_memory()) | |
has_kv_cache = any(kv_cache_spec for kv_cache_spec in kv_cache_specs) | |
if has_kv_cache: | |
available_gpu_memory = self.model_executor.determine_available_memory() | |
else: | |
# Attention free models don't need memory for kv cache | |
available_gpu_memory = [0] * len(kv_cache_specs) |
I feel that the condition is not correct. len(kv_cache_specs) can be larger than 1 when TP / PP is enabled.
Signed-off-by: Christian Pinto <christian.pinto@ibm.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thank you very much.
Super. Many thanks for your help. |
This PR enables support for attention free models by exploiting the the zero kv cache groups approach. This han been created as a follow-up from the discussions in #20577.
@heheda12345 please review.